Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use <details> in installation section #556

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

duesee
Copy link

@duesee duesee commented Nov 3, 2023

Hello 👋🏻

First of all, thank you for this fantastic tool! It already saved me from countless hours fiddling with openssl :-)

This PR aims to improve the README so that you can quickly "choose" your preferred installation method (and don't have to look at other methods). I used two nested levels of <details>. To quickly see if you like the result, you can open the rendered README in my fork.

I cherry-picked the commit from #526 and already integrated it into the structure.

The structure allows you to expand only the methods you are interested in. The downside is that the README could become more challenging to maintain. However, I suspect it makes it also a bit easier to add new methods in the future.

If you like the idea -- I'm not sure about it :-) -- I can try to improve the aesthetics of the <details>.

<summary>Build from source (requires Go 1.10+)</summary>

```sh
<not documented yet>
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new structure made it explicit that this wasn't documented. I can't provide this information, but having it here signals that it's possible (of course :-)). We could also remove it.


```
<details>
<summary>APT (Debian, Ubuntu, ...)</summary>
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions are from the cherry-pick.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants